<html>
<body>
<h1>How to install the application</h1>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; In the root folder of the package, you can see the hierarchy of the application. 
All thing you have to do to run the CIS application is to double click on the JAR file. But before that, you must ensure the environment on your machine
    <ul>
        <li>Ensure that you already have JRE installed on your local machine (client machine). You can refer to this page: 
            <a href="http://www.oracle.com/technetwork/java/javase/install-windows-141940.html">Install JRE on Windows</a> for details.</li>
        <li>Ensure that you already have the database server which will store the data of the application. 
            The default database server that is used for CIS application is MS SQL Server, version 2005 or higher. To see how to configure the database server,  
            please refer section <strong>How to configure database server for CIS system</strong> below.</li>
    </ul>
    <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
            src="file:/HELP_LOCATION\images\appHierarchy.png" 
            alt="Hierarchy of cis application">
 <h1>How to configure database server for CIS system</h1>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; There are 2 ways to configure database server for CIS application as the followings:
    <h2>1. Change the configuration in <b><font style="color: red">jdbc.properties</b></font> file</h2>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; All the configuration to establish the JDBC connection to database can be found in 
    <b><font style="color: red">jdbc.properties</b></font> in folder <b>config</b> :
    <ul>
        <li>jdbc.driver.class[=com.microsoft.sqlserver.jdbc.SQLServerDriver]: The driver class which is specific for every kind of database server</li>
        <li>jdbc.url.protocol.prefix[=jdbc:sqlserver://]: The protocol that you need to connect to the database platform</li>
        <li>jdbc.url.protocol.host[=localhost]: The host of database server</li>
        <li>jdbc.url.protocol.port[=1433]: The default port for the database service</li>
        <li>jdbc.url.properties.databaseName[=CIS]: The database name</li>
        <li>jdbc.username[=sa]: The username</li>
        <li>jdbc.password[=]: The password, leave blank if the password is empty</li>
        
    </ul>
    <h2>2. Change the configuration from GUI of CIS application</h2>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Run JAR file (CIS.jar) then go to <b>File -> Db Configure</b>
    You can modify the information of your database host and click Save button. You can use <b>Test connection</b> button to check that you 
    can connect to the database server with that information before you will save it.
    <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
            src="file:/HELP_LOCATION\images\DbConfigure.png" 
            alt="Hierarchy of cis application">
 <h1>Dummy data and scripts</h1>    
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To initialize the database, you have to run the SQL script. 
 All the scripts that used for CIS application are saved on <b>scripts</b> folder. The <b>CIS.sql</b> is the scripts allowing to create database and tables.
 Or if you do not want to run that .sql file, then you can import the dummy data exported by *.mdf file (CIS.mdf and CIS_log.LDF) in that folder.
    <h1>Product Master</h1>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The product master role can only works on the modules that related to product. After login successful to Campaign Information System (CIS), 
then some jobs the he can do with the system are:
    <ul>
        <li>Create a new product</li>
        <li>Search any product based on one or more criteria like Product id, Product Name,...</li>
        <li>Update an existing product</li>
        <li>Delete an existing product</li>
        <li>View statistics of campaign, variances, sales,...</li>
    </ul>

    <table style="margin-top: 10px">
        <tr>
            <td>
                <h2>1. How to create a new product</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\createProduct.png" 
                        alt="Create a product">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In order to create a product, you have to click on <b>Create</b> button from <b>Product Master</b> screen.
                The following steps help you to create a new product
                <ul>
                    <li>Enter information for Product ID, Product Name, Category or Description, ...</li>
                    <li>Click <b>Save</b> button</li>
                    <li>Button <b>Reset</b> may help you to clear all fields</li>
                    <li>The confirmation message dialog will be shown to ensure that you really want to create</li>
                    <li>If "Yes", then the new product will be created, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>2. How to search the product</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\searchProduct.png" 
                        alt="Search a product">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The following steps help you to search a product based on the criteria. From <b>Product Master</b> screen, you can:
                <ul>
                    <li>Enter the criteria about the product that you may want to search such as Product ID, Product Name, Product Category, Product Description</li>
                    <li>Click <b>Search</b> button</li>
                    <li>The results will be listed in the table below</li>
                    <li>If there's no products found, then a pop-up dialog message will inform you about that.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>3. How to update information for an existing product</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\updateProduct.png" 
                        alt="Update a product">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In order to update a product, you have to search and select the product you want to update, then click on <b>Update</b> button from <b>Product Master</b> screen.
                The following steps help you to update information for an existing product
                <ul>
                    <li>Change information for Product Name, Description, Category, ...</li>
                    <li>Product ID can not be changed during the update process</li>
                    <li>Click <b>Save</b> button</li>
                    <li>Button <b>Reset</b> may help you to reset the origin information of that product</li>
                    <li>The confirmation message dialog will be shown to ensure that you really want to update with the provided data</li>
                    <li>If "Yes", then the product will be updated, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>4. How to delete a product</h2>
                <p>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If you want to delete a specified product, you have to select that product and click on <b>Delete</b> button from <b>Product Master</b> screen.
                <ul>
                    <li>The confirmation message dialog will be shown to ensure that you really want to delete that product.</li>
                    <li>If you delete a product, then all relevant campaigns of that product will be also deleted.</li>
                    <li>If "Yes", then the product will be deleted, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>5. How to view statistics report</h2>
                <p>
                    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please see the report section for <b>Normal Employee</b>
            </td>
        </tr>
        
    </table>

<h1>Campaign Master</h1>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The campaign master has responsibility to manage the campaign on different products. 
    <ul>
        <li>Create a new campaign on specified product</li>
        <li>Search any campaign based on one or more criteria like Campaign ID, Campaign Name, Product ID, Channel ID,... 
                or even he can search based on the start date and/or end date of the campaign</li>
        <li>Update an existing campaign</li>
        <li>Delete an existing campaign</li>
        <li>Estimate sales and budget of campaign</li>
        <li>Input actual sales and budget of campaign</li>
        <li>View statistics of campaign, variances, sales,...</li>
    </ul> 
    <table style="margin-top: 10px">
        <tr>
            <td>
                <h2>1. How to create a new campaign</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\createCampaign.png" 
                        alt="Create a campaign">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In order to create a campaign, you have to click on <b>Create</b> button from <b>Campaign Master</b> screen.
                The following steps help you to create a new campaign
                <ul>
                    <li>Enter information for CampaignID, CampaignName, Start date, End date, ...</li>
                    <li>You can select Channel ID and Product ID as well as Promotion ID by clicking on <b>Select</b> correspondent button or you can type yourself</li>
                    <li>Click <b>Save</b> button</li>
                    <li>Button <b>Reset</b> may help you to clear all fields</li>
                    <li>The confirmation message dialog will be shown to ensure that you really want to create</li>
                    <li>If "Yes", then the new campaign will be created, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>2. How to search the campaign</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\searchCampaign.png" 
                        alt="Search a campaign">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The following steps help you to search a campaign based on the criteria. From <b>Campaign Master</b> screen, you can:
                <ul>
                    <li>Enter the criteria about the campaign that you may want to search</li>
                    <li>You can select Channel ID and Product ID to search by clicking on <b>Select</b> correspondent button</li>
                    <li>Click <b>Search</b> button</li>
                    <li>The results will be listed in the table below</li>
                    <li>If there's no campaigns found, then a pop-up dialog message will inform you about that.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>3. How to update information for an existing campaign</h2>
        <p>&nbsp;        
        <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
                        src="file:/HELP_LOCATION\images\updateCampaign.png" 
                        alt="Update a campaign">
                <br>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In order to update a campaign, you have to search and select the campaign you want to update, then click on <b>Update</b> button from <b>Campaign Master</b> screen.
                The following steps help you to update information for an existing campaign
                <ul>
                    <li>Enter information for CampaignName, Start date, End date, ...</li>
                    <li>You can select Channel ID and Product ID as well as Promotion ID by clicking on <b>Select</b> correspondent button or you can type yourself</li>
                    <li>Campaign ID can not be changed during the update process</li>
                    <li>Click <b>Save</b> button</li>
                    <li>Button <b>Reset</b> may help you to reset the origin information of that campaign</li>
                    <li>The confirmation message dialog will be shown to ensure that you really want to update with the provided data</li>
                    <li>If "Yes", then the campaign will be updated, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>4. How to delete a campaign</h2>
                <p>
                &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If you want to delete a specified campaign, you have to select that campaign and click on <b>Delete</b> button from <b>Campaign Master</b> screen.
                <ul>
                    <li>The confirmation message dialog will be shown to ensure that you really want to delete that campaign</li>
                    <li>If "Yes", then the campaign will be deleted, "No" option will do nothing.</li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>5. Estimate sales and budget of a campaign</h2>
                <p>
                    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The campaign master can do everything on campaign. He can estimate the sales target, budget of a campaign.
                    From the screen <b>Estimate campaign</b>, he can:
                <ul>
                    <li>Select a campaign to estimate</li>
                    <li>Input the estimate values for sales and budget, then click <b>Update</b></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>6. Input actual sales and budget of a campaign</h2>
                <p>
                    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;From the screen <b>Actual campaign</b>, the user can:
                <ul>
                    <li>Select a campaign to input the actual values</li>
                    <li>Input the actual values for sales and budget, then click <b>Update</b></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <h2>7. How to view statistics report</h2>
                <p>
                    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please see the report section for <b>Normal Employee</b>
            </td>
        </tr>
        
    </table>
<h1>Normal Employee</h1>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The normal employee can <b>only</b> view statistics of campaign, variances, sales,... in HTML format of the system. There are various report types provided:
    <ul>
        <li>Report based on mode [All or Selected item]</li>
        <li>Report based on what data he wants to report, i.e different campaigns on different products, report variances only, or sales target,...</li>
    </ul>
    <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img 
            src="file:/HELP_LOCATION\images\statisticsReport.png" 
            alt="Statistic report">
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The user has to choose both the mode and exported data to report. In case the user chooses the mode <i><b>Selected item</b></i> then, he has to select the item to export. 
    Otherwise, the system will show an error message dialog. After the report runs successfully, the default web browser will automatically opens the HTML report file. 
    
<h1>Administrator</h1>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The administrator can do everything on product, campaign, employee as well as he can assign(change) 
            the role of employee if he wants that employee to see the specific modules,...
</body>
</html>